Skip to content

feat: sync modules.json compatibility/docs from modules #1353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
danielroe merged 11 commits into from
Jan 14, 2026
Merged

feat: sync modules.json compatibility/docs from modules #1353

danielroe merged 11 commits into from
Jan 14, 2026
+599 −140

Conversation

@danielroe
Copy link
Member

@danielroe danielroe commented Jan 8, 2026

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

this uses module.json (emitted by nuxt/module-buidler) as source of truth for module compatibility + docs urls

we'll need to keep an eye on this - some modules seem to have incorrect compatibility (e.g. ^3.0.0 as opposed to >=3.0.0) so we can raise some upstream PRs

@danielroe danielroe requested a review from atinux January 8, 2026 21:02
@danielroe danielroe self-assigned this Jan 8, 2026
danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/lodash.yml
github: cipami
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.0.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note - we need to open a PR upstream

Copy link
Member

@atinux atinux Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Repo is archived: https://github.com/cipami/nuxt-lodash

What do you think of removing it instead?

@danielroe danielroe force-pushed the feat/sync-modules-json branch from a455973 to 8b10e57 Compare January 8, 2026 21:24
danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/xstate.yml
twitter: lexpeartha
compatibility:
nuxt: ^2.0.0 || >=3.0.0
nuxt: ^2.16.0 || ^3.0.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/well-known.yml
github: https://github.com/zadigetvoltaire
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.0.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/web-vitals.yml Outdated
bluesky: atinux.com
compatibility:
nuxt: ^2.0.0 || >=3.0.0
nuxt: ^3.0.0 || ^2.15.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/vue-query.yml
twitter: its_hebilicious
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/vue-email.yml
avatar: https://avatars.githubusercontent.com/u/35883748?v=4
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.0.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/vcalendar.yml
github: samk-dev
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.0.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/radash.yml
github: bbg
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.0.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/purgecss.yml
github: Developmint
compatibility:
nuxt: ^2.0.0 || >=3.0.0
nuxt: ^3.0.0-rc.11
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

Copy link
Member

@atinux atinux Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You already opened it @danielroe
Developmint/nuxt-purgecss#199

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/particles.yml
avatar: https://avatars.githubusercontent.com/Joepocalyptic?v=4
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.7.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

Copy link
Member

@atinux atinux Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Joepocalyptic/nuxt-particles#33

danielroe
danielroe commented Jan 8, 2026
View reviewed changes
modules/nuxt-uswds.yml
github: patrickcate
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.0.0
Copy link
Member Author

@danielroe danielroe Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: needs PR

atinux
atinux reviewed Jan 9, 2026
View reviewed changes
modules/lodash.yml
github: cipami
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.0.0
Copy link
Member

@atinux atinux Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Repo is archived: https://github.com/cipami/nuxt-lodash

What do you think of removing it instead?

modules/nuxt-chatgpt.yml
github: schnapsterdog
compatibility:
nuxt: '>=3.0.0'
nuxt: '>=3.0.0 <5.0.0'
Copy link
Member

@atinux atinux Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened SchnapsterDog/nuxt-chatgpt#36 to avoid having this <5

modules/particles.yml
avatar: https://avatars.githubusercontent.com/Joepocalyptic?v=4
compatibility:
nuxt: '>=3.0.0'
nuxt: ^3.7.0
Copy link
Member

@atinux atinux Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Joepocalyptic/nuxt-particles#33

modules/purgecss.yml
github: Developmint
compatibility:
nuxt: ^2.0.0 || >=3.0.0
nuxt: ^3.0.0-rc.11
Copy link
Member

@atinux atinux Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You already opened it @danielroe
Developmint/nuxt-purgecss#199

@danielroe
Copy link
Member Author

danielroe commented Jan 9, 2026

here's the full list of modules that mark themselves as compatible with 3.x but not 4.x:

https://github.com/iamdin/nuxt-ark-ui
https://github.com/hamlogic/nuxt-cloudflare-analytics
https://github.com/content-island/nuxt-content-island
https://github.com/patrickcate/nuxt-jsonapi
https://github.com/nuxtlabs/nuxt-llms
https://github.com/cipami/nuxt-lodash
https://github.com/productdevbook/nitro-graphql
https://github.com/lorexiq/nuxt-color-picker
https://github.com/superdev-tech/nuxt-facebook-chat
https://github.com/onmax/nuxt-formisch
https://github.com/holux-design/nuxt-GPT
https://github.com/zadigetvoltaire/nuxt-gtm
https://github.com/nuxtus/localtunnel
https://github.com/superdev-tech/nuxt-plotly
https://github.com/cpsoinos/nuxt-svgo
https://github.com/halitsever/nuxt-telegram-auth
https://github.com/patrickcate/nuxt-uswds
https://github.com/Joepocalyptic/nuxt-particles
https://github.com/Developmint/nuxt-purgecss#main
https://github.com/bbg/nuxt-radash
https://github.com/getsentry/sentry-javascript#HEAD/packages/nuxt
https://github.com/nuxt-modules/snipcart
https://github.com/filipsobol/sonda#release/packages/sonda
https://github.com/paranoidphantom/tgauth
https://github.com/samk-dev/nuxt-vcalendar
https://github.com/vue-email/nuxt
https://github.com/Hebilicious/vue-query-nuxt#main/packages/vue-query-nuxt
https://github.com/nuxt-modules/web-vitals
https://github.com/zadigetvoltaire/nuxt-well-known
https://github.com/Lexpeartha/nuxt-xstate

@danielroe
Copy link
Member Author

danielroe commented Jan 14, 2026

here's the latest:

Regressions detected (36):
  - [compatibility] ark-ui: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] api-party: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] cloudflare-analytics: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [docs-url] contentstack: Module had a documentation site (https://nuxt-contentstack-docs.eu-contentstackapps.com/) but module.json now points to https://github.com/timbenniks/nuxt-contentstack
  - [compatibility] bugsnag: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^2.16.0 || ^3.0.0-rc.10
  - [compatibility] google-adsense: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^2.15.0 || ^3.0.0-rc.11
  - [compatibility] gtag: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] icons: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0-rc.3
  - [compatibility] jsonapi: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] lodash: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] link-checker: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] meilisearch: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0-rc.9
  - [compatibility] nuxt-facebook-chat: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.6.0
  - [compatibility] nuxt-gpt: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] nuxt-gtm: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] nuxt-graphql-middleware: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] nuxt-localtunnel: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] nuxt-legacy: Module was marked as Nuxt 4 compatible (>=3.15.0) but module.json indicates only ^3.0.0 || >=4.0.3
  - [compatibility] nuxt-plotly: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.6.0
  - [compatibility] nuxt-uswds: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] pdfeasy: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] particles: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.7.0
  - [compatibility] og-image: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] purgecss: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^3.0.0-rc.11
  - [compatibility] radash: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] rollbar: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3
  - [compatibility] snipcart: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] supabase: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^3.0.0-rc.8
  - [compatibility] typed-router: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^3.0.0-rc.1
  - [compatibility] umami: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^2.0.0 || ^3.0.0-rc.9
  - [compatibility] vcalendar: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] vue-query: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3
  - [compatibility] vue-email: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] web-vitals: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^2.15.0 || ^3.0.0
  - [compatibility] well-known: Module was marked as Nuxt 4 compatible (>=3.0.0) but module.json indicates only ^3.0.0
  - [compatibility] xstate: Module was marked as Nuxt 4 compatible (^2.0.0 || >=3.0.0) but module.json indicates only ^2.16.0 || ^3.0.0

@danielroe danielroe marked this pull request as draft January 14, 2026 17:21
@danielroe
Copy link
Member Author

danielroe commented Jan 14, 2026

current status:

Module Status PR Link
ark-ui Existing PR open iamdin/nuxt-ark-ui#32
cloudflare-analytics Existing PR open hamlogic/nuxt-cloudflare-analytics#9
contentstack Resolved - yml already updated N/A
jsonapi PR created patrickcate/nuxt-jsonapi#644
lodash Existing PR open cipami/nuxt-lodash#62
nuxt-facebook-chat Source already correct (>=3.6.0), needs npm publish N/A
nuxt-gpt Existing PR open holux-design/nuxt-GPT#1
nuxt-gtm Existing PR open zadigetvoltaire/nuxt-gtm#34
nuxt-legacy Source already correct (^3.18.0 || >=4.0.3), needs npm publish N/A
nuxt-localtunnel Existing PR open nuxtus/localtunnel#28
nuxt-plotly PR created superdev-tech/nuxt-plotly#12
nuxt-uswds Existing PR open patrickcate/nuxt-uswds#59
particles Existing PR open Joepocalyptic/nuxt-particles#25
pdfeasy Source already correct (>=3.0.0), needs npm publish N/A
purgecss Source already correct (>=3.0.0-rc.11), needs npm publish N/A
radash Existing PR open bbg/nuxt-radash#4
rollbar Source already correct (>=3), needs npm publish N/A
snipcart Source already correct (>=3.0.0), needs npm publish N/A
vcalendar Existing PR open samk-dev/nuxt-vcalendar#27
vue-email Repo archived - cannot create PR N/A
vue-query Source already correct (>=3), needs npm publish N/A
web-vitals Existing PR open nuxt-modules/web-vitals#87
well-known Source already correct (>=3.0.0), needs npm publish N/A
xstate Existing PR open Lexpeartha/nuxt-xstate#60

apologies for the mass ping, but:

thank you - and apologies for the noise 🙏

@danielroe danielroe marked this pull request as ready for review January 14, 2026 17:48
@danielroe danielroe merged commit ca6929e into main Jan 14, 2026
3 checks passed
@danielroe danielroe deleted the feat/sync-modules-json branch January 14, 2026 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@atinux atinux atinux left review comments

Assignees

@danielroe danielroe

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@danielroe @atinux